/*
 * Copyright (C) 2019 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.copybara.transform;

import com.google.copybara.exception.NonReversibleValidationException;
import java.util.function.Function;
import net.starlark.java.annot.StarlarkBuiltin;
import net.starlark.java.eval.StarlarkValue;

@StarlarkBuiltin(
    name = "mapping_function",
    doc = "A function that given an object can map to another object")
public interface ReversibleFunction<T, R> extends Function<T, R>, StarlarkValue {

  /**
   * Create a reverse of the function
   */
  ReversibleFunction<R, T> reverseMapping() throws NonReversibleValidationException;
}
